<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Reranker Framework (ReFr): reranker::ExecutiveFeatureExtractor Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Reranker Framework (ReFr)
   
   </div>
   <div id="projectbrief">Reranking framework for structure prediction and discriminative language modeling</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacereranker.html">reranker</a>      </li>
      <li class="navelem"><a class="el" href="classreranker_1_1_executive_feature_extractor.html">ExecutiveFeatureExtractor</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">reranker::ExecutiveFeatureExtractor Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="reranker::ExecutiveFeatureExtractor" -->
<p>This class is like a regular <a class="el" href="classreranker_1_1_feature_extractor.html" title="An abstract base class/interface for all feature extractors.">FeatureExtractor</a>, but has been promoted to the executive level and thus wears fancypants.  
 <a href="classreranker_1_1_executive_feature_extractor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="executive-feature-extractor_8_h_source.html">executive-feature-extractor.H</a>&gt;</code></p>

<p><a href="classreranker_1_1_executive_feature_extractor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#af8d79eaac520cd20c55e18db39c52118">ExecutiveFeatureExtractor</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new intance.  <a href="#af8d79eaac520cd20c55e18db39c52118"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab4d9fe507023800afd459194f364b5be">~ExecutiveFeatureExtractor</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this instance.  <a href="#ab4d9fe507023800afd459194f364b5be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab970de3165f9979a995011c520b0813f">Init</a> (const string &amp;filename)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this instance from the feature extractor specifications in the specified file.  <a href="#ab970de3165f9979a995011c520b0813f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab5a5394498b8c2ab3cc418c08aaff3ba">Init</a> (istream &amp;is)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this instance from the feature extractor specifications in the specified input stream.  <a href="#ab5a5394498b8c2ab3cc418c08aaff3ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#aa917a1e2e3730ba8858b8e8db0d50ec3">Reset</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Indictes to this instance that iteration has been reset.  <a href="#aa917a1e2e3730ba8858b8e8db0d50ec3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#ae825fd69b80d636cb12d95e39a1c3e20">Extract</a> (<a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> &amp;candidate_set) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts features for the specified <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> using the suite of <a class="el" href="classreranker_1_1_feature_extractor.html" title="An abstract base class/interface for all feature extractors.">FeatureExtractor</a> instances specified at construction time.  <a href="#ae825fd69b80d636cb12d95e39a1c3e20"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is like a regular <a class="el" href="classreranker_1_1_feature_extractor.html" title="An abstract base class/interface for all feature extractors.">FeatureExtractor</a>, but has been promoted to the executive level and thus wears fancypants. </p>
<p>More specifically, this class executes the extraction of a suite of feature extractors, specified at run-time via a set of string specifications, which are typically read from a file.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>FeatureExtractorFactory </dd></dl>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_h_source.html#l00067">67</a> of file <a class="el" href="executive-feature-extractor_8_h_source.html">executive-feature-extractor.H</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af8d79eaac520cd20c55e18db39c52118"></a><!-- doxytag: member="reranker::ExecutiveFeatureExtractor::ExecutiveFeatureExtractor" ref="af8d79eaac520cd20c55e18db39c52118" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classreranker_1_1_executive_feature_extractor.html#af8d79eaac520cd20c55e18db39c52118">reranker::ExecutiveFeatureExtractor::ExecutiveFeatureExtractor</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructs a new intance. </p>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_h_source.html#l00070">70</a> of file <a class="el" href="executive-feature-extractor_8_h_source.html">executive-feature-extractor.H</a>.</p>

</div>
</div>
<a class="anchor" id="ab4d9fe507023800afd459194f364b5be"></a><!-- doxytag: member="reranker::ExecutiveFeatureExtractor::~ExecutiveFeatureExtractor" ref="ab4d9fe507023800afd459194f364b5be" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab4d9fe507023800afd459194f364b5be">reranker::ExecutiveFeatureExtractor::~ExecutiveFeatureExtractor</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destroys this instance. </p>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_h_source.html#l00072">72</a> of file <a class="el" href="executive-feature-extractor_8_h_source.html">executive-feature-extractor.H</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae825fd69b80d636cb12d95e39a1c3e20"></a><!-- doxytag: member="reranker::ExecutiveFeatureExtractor::Extract" ref="ae825fd69b80d636cb12d95e39a1c3e20" args="(CandidateSet &amp;candidate_set) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_executive_feature_extractor.html#ae825fd69b80d636cb12d95e39a1c3e20">reranker::ExecutiveFeatureExtractor::Extract</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> &amp;&#160;</td>
          <td class="paramname"><em>candidate_set</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Extracts features for the specified <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> using the suite of <a class="el" href="classreranker_1_1_feature_extractor.html" title="An abstract base class/interface for all feature extractors.">FeatureExtractor</a> instances specified at construction time. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">candidate_set</td><td>the <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> for which to extract features </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_c_source.html#l00086">86</a> of file <a class="el" href="executive-feature-extractor_8_c_source.html">executive-feature-extractor.C</a>.</p>

</div>
</div>
<a class="anchor" id="ab970de3165f9979a995011c520b0813f"></a><!-- doxytag: member="reranker::ExecutiveFeatureExtractor::Init" ref="ab970de3165f9979a995011c520b0813f" args="(const string &amp;filename)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab970de3165f9979a995011c520b0813f">reranker::ExecutiveFeatureExtractor::Init</a> </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>filename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes this instance from the feature extractor specifications in the specified file. </p>
<p>A feature extractor specification is a line that is of the form<br/>
 </p>
<div class="fragment"><pre class="fragment"> FeatureExtractorClassName(init_arg) 
</pre></div> <p>More formally, each line must have the form </p>
<div class="fragment"><pre class="fragment"> &lt;feature extractor classname&gt; &lt;lparen&gt; &lt;init str&gt; &lt;rparen&gt;
</pre></div><p> where </p>
<table  border="0">
<tr>
<td><code>&lt;feature extractor classname&gt;</code> </td><td><code>::=</code> </td><td>the string passed to the <a class="el" href="factory_8_h.html#a0b09e4aaef613d7556c07875c7d5a029">REGISTER_NAMED</a> macro by a <a class="el" href="classreranker_1_1_feature_extractor.html">FeatureExtractor</a> implementation  </td></tr>
<tr>
<td><code>&lt;lparen&gt;</code> </td><td><code>::=</code> </td><td>a left parenthesis character, <code>'('</code>  </td></tr>
<tr>
<td><code>&lt;init str&gt;</code> </td><td><code>::=</code> </td><td>an initialization string to be passed to the newly-constructed <a class="el" href="classreranker_1_1_feature_extractor.html">FeatureExtractor</a>&rsquo;s <a class="el" href="classreranker_1_1_feature_extractor.html#a2ec99fbd293b35e90f9553a729e6f649">FeatureExtractor::Init</a> method   </td></tr>
<tr>
<td><code>&lt;rparen&gt;</code> </td><td><code>::=</code> </td><td>a right parenthesis character, <code>')'</code>  </td></tr>
</table>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>the name of a file containing a set of feature extractor specifications, one per line</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>Factory::Create(const string&amp;,string&amp;,string&amp;,bool&amp;,bool&amp;) </dd></dl>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_c_source.html#l00062">62</a> of file <a class="el" href="executive-feature-extractor_8_c_source.html">executive-feature-extractor.C</a>.</p>

</div>
</div>
<a class="anchor" id="ab5a5394498b8c2ab3cc418c08aaff3ba"></a><!-- doxytag: member="reranker::ExecutiveFeatureExtractor::Init" ref="ab5a5394498b8c2ab3cc418c08aaff3ba" args="(istream &amp;is)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab970de3165f9979a995011c520b0813f">reranker::ExecutiveFeatureExtractor::Init</a> </td>
          <td>(</td>
          <td class="paramtype">istream &amp;&#160;</td>
          <td class="paramname"><em>is</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes this instance from the feature extractor specifications in the specified input stream. </p>
<p>A feature extractor specification is a line that is of the form<br/>
 </p>
<div class="fragment"><pre class="fragment"> FeatureExtractorClassName(init_arg) 
</pre></div><p> Please see the documentation for the <a class="el" href="classreranker_1_1_executive_feature_extractor.html#ab970de3165f9979a995011c520b0813f">Init(const string&amp;)</a> method for the formal specification.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">is</td><td>an input stream containing a set of feature extractor specifications, one per line </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_c_source.html#l00068">68</a> of file <a class="el" href="executive-feature-extractor_8_c_source.html">executive-feature-extractor.C</a>.</p>

</div>
</div>
<a class="anchor" id="aa917a1e2e3730ba8858b8e8db0d50ec3"></a><!-- doxytag: member="reranker::ExecutiveFeatureExtractor::Reset" ref="aa917a1e2e3730ba8858b8e8db0d50ec3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_executive_feature_extractor.html#aa917a1e2e3730ba8858b8e8db0d50ec3">reranker::ExecutiveFeatureExtractor::Reset</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Indictes to this instance that iteration has been reset. </p>
<p>This is especially important for file-backed feature extractors.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classreranker_1_1_feature_extractor.html#aff5c63502be6a9e662d0db49a174a5f7" title="Indicates to this instance that iteration over candidate sets on which features are being extracted h...">FeatureExtractor::Reset</a> </dd></dl>

<p>Definition at line <a class="el" href="executive-feature-extractor_8_c_source.html#l00076">76</a> of file <a class="el" href="executive-feature-extractor_8_c_source.html">executive-feature-extractor.C</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="executive-feature-extractor_8_h_source.html">executive-feature-extractor.H</a></li>
<li><a class="el" href="executive-feature-extractor_8_c_source.html">executive-feature-extractor.C</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Tue Apr 9 2013 11:56:30 for Reranker Framework (ReFr) by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
